Crate dusk_poseidon

Expand description

Dusk-Poseidon

Reference implementation for the Poseidon Hashing algorithm.

Reference

Starkad and Poseidon: New Hash Functions for Zero Knowledge Proof Systems

This repository has been created so there’s a unique library that holds the tools & functions required to perform Poseidon Hashes.

This hashes heavily rely on the Hades permutation, which is one of the key parts that Poseidon needs in order to work. This library uses the reference implementation of Dusk-Hades which has been designed & build by the Dusk-Network team.

The library provides the two hashing techniques of Poseidon:

Sponge Hash

The Sponge technique in Poseidon allows to hash an unlimited amount of data into a single Scalar. The sponge hash technique requires a padding to be applied before the data can be hashed.

This is done to avoid hash collisions as stated in the paper of the Poseidon Hash algorithm. See: https://eprint.iacr.org/2019/458.pdf. The inputs of the sponge_hash are always Scalar or need to be capable of being represented as it.

The module provides two sponge hash implementations:

Sponge hash using Scalar as backend. Which hashes the inputted Scalars and returns a single Scalar.
Sponge hash gadget using dusk_plonk::Witness as a backend. This technique is used/required when you want to proof pre-images of unconstrained data inside Zero-Knowledge PLONK circuits.

Documentation

This crate contains info about all the functions that the library provides as well as the documentation regarding the data structures that it exports. To check it, please feel free to go to the documentation page

Benchmarks

There are benchmarks for sponge and cipher in their native form, operating on Scalar, and as a zero-knowledge gadget, using Witness.

To run all benchmarks on your machine, run

cargo bench

in the repository.

To run a specific benchmark, run

cargo bench --bench <name>

where you replace <name> with the benchmark name. For example to run the benchmarks for the poseidon cipher encription from the file ‘benches/cipher_encrypt.rs’, you would need to run

cargo bench --benches cipher_encrypt

If you want to contribute to this repository/project please, check CONTRIBUTING.md
If you want to report a bug or request a new feature addition, please open an issue on this repository.

Modules

cipher
Encryption and decryption implementation over a Poseidon cipher
perm_uses
Module containing a fixed-length Poseidon hash implementation with one input scalar and two output scalar The pad module implements the padding algorithm on the Poseidon hash.
sponge
Implementation for the Poseidon Sponge hash function